/**
 * File ConversionProgressEvent.java
 * ---------------------------------------------------------
 *
 * Copyright (C) 2012 David Bauske (david.bauske@googlemail.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * - The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 * - The origin of the software must not be misrepresented.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * TL;DR: As long as you clearly give me credit for this Software, you are free to use as you like, even in commercial software, but don't blame me
 * 		if it breaks something.
 */
package de.erb.erir.model;

import net.cl.util.patterns.DefaultProgressEvent;

/**
 * Event class for the ImageConversionWorker. Faetures a status code field in addition to the default progress event
 * fields.
 *
 * @author David
 */
public class ConversionProgressEvent extends DefaultProgressEvent<ImageConversionWorker>
{
	public enum Status
	{
		OK,
		DONE_FILES_CONVERTED,
		DONE_NO_CENVERTIBLE_FILES,
		IO_ERROR,
		CANCELLED,
		UNKNOWN_ERROR,
	}

	private Status	mStatusCode;

	public ConversionProgressEvent(ImageConversionWorker pSource, double pPercentage)
	{
		super(pSource, pPercentage);
		mStatusCode = Status.OK;
	}

	public ConversionProgressEvent(ImageConversionWorker pSource, double pPercentage, Status pStatus)
	{
		super(pSource, pPercentage);

		if(pStatus == null)
		{
			throw new NullPointerException("pStatus may not be null");
		}

		mStatusCode = pStatus;
	}

	public ConversionProgressEvent(ImageConversionWorker pSource, double pPercentage,
			Status pStatus, String pStatusMessage)
	{
		super(pSource, pPercentage, pStatusMessage);

		if(pStatus == null)
		{
			throw new NullPointerException("pStatus may not be null");
		}

		mStatusCode = pStatus;
	}

	public Status getStatusCode()
	{
		return mStatusCode;
	}
}
